v2.15.1 Adding limit_response to get_tasks method #80
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonathanfeng-scale
approved these changes
Nov 4, 2023
scaleapi/__init__.py
Outdated
| @@ -273,6 +273,9 @@ def tasks(self, **kwargs) -> Tasklist: | |||
| If true, returns a pre-signed s3 url for the | |||
| attachment used to create the task. | |||
|
|
|||
| limited_response (bool): | |||
| If true, returns limited task response. | |||
There was a problem hiding this comment.
can we document what fields are returned in the limited_response?
There was a problem hiding this comment.
Agree, we can both document it in this comment section as well as document it in the Readme with more details.
There was a problem hiding this comment.
Got it! Just updated with the new version specifying fields to be returned as comments and also added to the readme
scaleapi/__init__.py
Outdated
| @@ -392,6 +397,9 @@ def get_tasks( | |||
| If true, returns a pre-signed s3 url for the | |||
| attachment used to create the task. | |||
|
|
|||
| limited_response (bool): | |||
| If true, returns limited task response. | |||
There was a problem hiding this comment.
probably document it here too, just so people know in the future what it is instead of asking us 😆
lautarorangil
approved these changes
Nov 6, 2023
fatihkurtoglu
changed the title
fatihkurtoglu
approved these changes
Nov 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Summary
Description
Added the limited_response argument to the get_tasks() method
How did you test your code?
Which of the following have you done to test your changes? Please describe the tests that you ran to verify your changes.
tests/for the newly implemented methodstests/to cover changes made to existing methodsChecklist
Please make sure all items in this checklist have been fulfilled before sending your PR out for review!
_version.py(unless this PR only updates the documentation).